home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / JAVA_ALL / IDE / SUBARTIC / SUB_ARCT / LIB / TRAVERSA.JAV < prev    next >
Encoding:
Text File  |  1996-10-04  |  1.9 KB  |  51 lines
  1.  
  2. package sub_arctic.lib;
  3.  
  4. /** 
  5.  * Interface representing an object that transforms a set of "parameter" 
  6.  * values from those suitable for use by a parent object into a set suitable 
  7.  * for use by a child object (for example, during a traversal using 
  8.  * traverse_and_collect()).
  9.  *  
  10.  *  @see sub_arctic.lib.interactor#traverse_and_collect
  11.  *  @author Scott Hudson 
  12.  */
  13. public interface traversal_xform {
  14.   /** Perform the transformation.
  15.    *  
  16.    *  @param parent_parameters an object representing parameter values as set
  17.    *                           up for the parent object.
  18.    *  @param child_obj         the child object that the parameter values 
  19.    *                           should be transformed for use by (a common 
  20.    *                           example would be to transform a point from the
  21.    *                           parent's coordinate system into this child 
  22.    *                           object's coordinate system).
  23.    *  @return the resulting transformed parameters object.  Note: this can
  24.    *          be the same object passes in.
  25.    */
  26.   public Object xform(
  27.     Object     parent_parameters, 
  28.     interactor child_obj, 
  29.     int        child_index);
  30.  
  31.    //had:
  32.    //*@exception sub_arctic.exception.bad_value thrown if the parent_parameters 
  33.    //* parameter is not the proper type.
  34. };
  35. /*=========================== COPYRIGHT NOTICE ===========================
  36.  
  37. This file is part of the subArctic user interface toolkit.
  38.  
  39. Copyright (c) 1996 Scott Hudson and Ian Smith
  40. All rights reserved.
  41.  
  42. The subArctic system is freely available for most uses under the terms
  43. and conditions described in 
  44.   http://www.cc.gatech.edu/gvu/ui/sub_arctic/sub_arctic/doc/usage.html 
  45. and appearing in full in the lib/interactor.java source file.
  46.  
  47. The current release and additional information about this software can be 
  48. found starting at: http://www.cc.gatech.edu/gvu/ui/sub_arctic/
  49.  
  50. ========================================================================*/
  51.